com.inscoper.nbo.Plane¶

Represents the XML element Plane. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	Plane()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setID(PlaneID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(PlaneID_Type value) Sets the value of the ID attribute.
PlaneID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setTheZ(NonNegativeInt_Type value, boolean validate) Sets the value of the TheZ attribute.
void	setTheZ(NonNegativeInt_Type value) Sets the value of the TheZ attribute.
NonNegativeInt_Type	getTheZ() Returns the value of the TheZ attribute.
void	resetTheZ() Resets the TheZ attribute to an unset state.
boolean	hasTheZ() Checks whether the optional TheZ attribute is present.
void	setTheT(NonNegativeInt_Type value, boolean validate) Sets the value of the TheT attribute.
void	setTheT(NonNegativeInt_Type value) Sets the value of the TheT attribute.
NonNegativeInt_Type	getTheT() Returns the value of the TheT attribute.
void	resetTheT() Resets the TheT attribute to an unset state.
boolean	hasTheT() Checks whether the optional TheT attribute is present.
void	setTheC(NonNegativeInt_Type value, boolean validate) Sets the value of the TheC attribute.
void	setTheC(NonNegativeInt_Type value) Sets the value of the TheC attribute.
NonNegativeInt_Type	getTheC() Returns the value of the TheC attribute.
void	resetTheC() Resets the TheC attribute to an unset state.
boolean	hasTheC() Checks whether the optional TheC attribute is present.
void	setTimestamp(float value, boolean validate) Sets the value of the Timestamp attribute.
void	setTimestamp(float value) Sets the value of the Timestamp attribute.
float	getTimestamp() Returns the value of the Timestamp attribute.
void	resetTimestamp() Resets the Timestamp attribute to an unset state.
boolean	hasTimestamp() Checks whether the Timestamp attribute is present.
void	setTimestampUnit(UnitsTime_Type value, boolean validate) Sets the value of the TimestampUnit attribute.
void	setTimestampUnit(UnitsTime_Type value) Sets the value of the TimestampUnit attribute.
UnitsTime_Type	getTimestampUnit() Returns the value of the TimestampUnit attribute.
void	resetTimestampUnit() Resets the TimestampUnit attribute to an unset state.
boolean	hasTimestampUnit() Checks whether the optional TimestampUnit attribute is present.
void	setExposureTime(float value, boolean validate) Sets the value of the ExposureTime attribute.
void	setExposureTime(float value) Sets the value of the ExposureTime attribute.
float	getExposureTime() Returns the value of the ExposureTime attribute.
void	resetExposureTime() Resets the ExposureTime attribute to an unset state.
boolean	hasExposureTime() Checks whether the ExposureTime attribute is present.
void	setExposureTimeUnit(UnitsTime_Type value, boolean validate) Sets the value of the ExposureTimeUnit attribute.
void	setExposureTimeUnit(UnitsTime_Type value) Sets the value of the ExposureTimeUnit attribute.
UnitsTime_Type	getExposureTimeUnit() Returns the value of the ExposureTimeUnit attribute.
void	resetExposureTimeUnit() Resets the ExposureTimeUnit attribute to an unset state.
boolean	hasExposureTimeUnit() Checks whether the optional ExposureTimeUnit attribute is present.
void	setPixelDwellTime(float value, boolean validate) Sets the value of the PixelDwellTime attribute.
void	setPixelDwellTime(float value) Sets the value of the PixelDwellTime attribute.
float	getPixelDwellTime() Returns the value of the PixelDwellTime attribute.
void	resetPixelDwellTime() Resets the PixelDwellTime attribute to an unset state.
boolean	hasPixelDwellTime() Checks whether the PixelDwellTime attribute is present.
void	setPixelDwellTimeUnit(UnitsTime_Type value, boolean validate) Sets the value of the PixelDwellTimeUnit attribute.
void	setPixelDwellTimeUnit(UnitsTime_Type value) Sets the value of the PixelDwellTimeUnit attribute.
UnitsTime_Type	getPixelDwellTimeUnit() Returns the value of the PixelDwellTimeUnit attribute.
void	resetPixelDwellTimeUnit() Resets the PixelDwellTimeUnit attribute to an unset state.
boolean	hasPixelDwellTimeUnit() Checks whether the optional PixelDwellTimeUnit attribute is present.
void	setPositionX(float value, boolean validate) Sets the value of the PositionX attribute.
void	setPositionX(float value) Sets the value of the PositionX attribute.
float	getPositionX() Returns the value of the PositionX attribute.
void	resetPositionX() Resets the PositionX attribute to an unset state.
boolean	hasPositionX() Checks whether the PositionX attribute is present.
void	setPositionXUnit(UnitsLength_Type value, boolean validate) Sets the value of the PositionXUnit attribute.
void	setPositionXUnit(UnitsLength_Type value) Sets the value of the PositionXUnit attribute.
UnitsLength_Type	getPositionXUnit() Returns the value of the PositionXUnit attribute.
void	resetPositionXUnit() Resets the PositionXUnit attribute to an unset state.
boolean	hasPositionXUnit() Checks whether the optional PositionXUnit attribute is present.
void	setPositionY(float value, boolean validate) Sets the value of the PositionY attribute.
void	setPositionY(float value) Sets the value of the PositionY attribute.
float	getPositionY() Returns the value of the PositionY attribute.
void	resetPositionY() Resets the PositionY attribute to an unset state.
boolean	hasPositionY() Checks whether the PositionY attribute is present.
void	setPositionYUnit(UnitsLength_Type value, boolean validate) Sets the value of the PositionYUnit attribute.
void	setPositionYUnit(UnitsLength_Type value) Sets the value of the PositionYUnit attribute.
UnitsLength_Type	getPositionYUnit() Returns the value of the PositionYUnit attribute.
void	resetPositionYUnit() Resets the PositionYUnit attribute to an unset state.
boolean	hasPositionYUnit() Checks whether the optional PositionYUnit attribute is present.
void	setPositionZ(float value, boolean validate) Sets the value of the PositionZ attribute.
void	setPositionZ(float value) Sets the value of the PositionZ attribute.
float	getPositionZ() Returns the value of the PositionZ attribute.
void	resetPositionZ() Resets the PositionZ attribute to an unset state.
boolean	hasPositionZ() Checks whether the PositionZ attribute is present.
void	setPositionZUnit(UnitsLength_Type value, boolean validate) Sets the value of the PositionZUnit attribute.
void	setPositionZUnit(UnitsLength_Type value) Sets the value of the PositionZUnit attribute.
UnitsLength_Type	getPositionZUnit() Returns the value of the PositionZUnit attribute.
void	resetPositionZUnit() Resets the PositionZUnit attribute to an unset state.
boolean	hasPositionZUnit() Checks whether the optional PositionZUnit attribute is present.
void	setPlaneXOffset(float value, boolean validate) Sets the value of the PlaneXOffset attribute.
void	setPlaneXOffset(float value) Sets the value of the PlaneXOffset attribute.
float	getPlaneXOffset() Returns the value of the PlaneXOffset attribute.
void	resetPlaneXOffset() Resets the PlaneXOffset attribute to an unset state.
boolean	hasPlaneXOffset() Checks whether the PlaneXOffset attribute is present.
void	setPlaneYOffset(float value, boolean validate) Sets the value of the PlaneYOffset attribute.
void	setPlaneYOffset(float value) Sets the value of the PlaneYOffset attribute.
float	getPlaneYOffset() Returns the value of the PlaneYOffset attribute.
void	resetPlaneYOffset() Resets the PlaneYOffset attribute to an unset state.
boolean	hasPlaneYOffset() Checks whether the PlaneYOffset attribute is present.
void	setPlaneZOffset(float value, boolean validate) Sets the value of the PlaneZOffset attribute.
void	setPlaneZOffset(float value) Sets the value of the PlaneZOffset attribute.
float	getPlaneZOffset() Returns the value of the PlaneZOffset attribute.
void	resetPlaneZOffset() Resets the PlaneZOffset attribute to an unset state.
boolean	hasPlaneZOffset() Checks whether the PlaneZOffset attribute is present.
void	setMechanicalCalibration_List(MechanicalCalibrationVector value, boolean validate) Sets the list of MechanicalCalibration elements.
void	setMechanicalCalibration_List(MechanicalCalibrationVector value) Sets the list of MechanicalCalibration elements.
MechanicalCalibrationVector	getMechanicalCalibration_List() Returns the list of MechanicalCalibration elements.
void	addToMechanicalCalibration_List(MechanicalCalibration value, boolean validate) Adds a new MechanicalCalibration element to this object.
void	addToMechanicalCalibration_List(MechanicalCalibration value) Adds a new MechanicalCalibration element to this object.
void	clearMechanicalCalibration_List() Clear the list of MechanicalCalibration.
void	setTheAdditionalDimensionRef_List(TheAdditionalDimensionRefVector value, boolean validate) Sets the list of TheAdditionalDimensionRef elements.
void	setTheAdditionalDimensionRef_List(TheAdditionalDimensionRefVector value) Sets the list of TheAdditionalDimensionRef elements.
TheAdditionalDimensionRefVector	getTheAdditionalDimensionRef_List() Returns the list of TheAdditionalDimensionRef elements.
void	addToTheAdditionalDimensionRef_List(TheAdditionalDimensionRef value, boolean validate) Adds a new TheAdditionalDimensionRef element to this object.
void	addToTheAdditionalDimensionRef_List(TheAdditionalDimensionRef value) Adds a new TheAdditionalDimensionRef element to this object.
void	clearTheAdditionalDimensionRef_List() Clear the list of TheAdditionalDimensionRef.
void	setPlaneTransformationMatrix_List(PlaneTransformationMatrixVector value, boolean validate) Sets the list of PlaneTransformationMatrix elements.
void	setPlaneTransformationMatrix_List(PlaneTransformationMatrixVector value) Sets the list of PlaneTransformationMatrix elements.
PlaneTransformationMatrixVector	getPlaneTransformationMatrix_List() Returns the list of PlaneTransformationMatrix elements.
void	addToPlaneTransformationMatrix_List(PlaneTransformationMatrix value, boolean validate) Adds a new PlaneTransformationMatrix element to this object.
void	addToPlaneTransformationMatrix_List(PlaneTransformationMatrix value) Adds a new PlaneTransformationMatrix element to this object.
void	clearPlaneTransformationMatrix_List() Clear the list of PlaneTransformationMatrix.
void	setAnnotationRef_List(AnnotationRefVector value, boolean validate) Sets the list of AnnotationRef elements.
void	setAnnotationRef_List(AnnotationRefVector value) Sets the list of AnnotationRef elements.
AnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(AnnotationRef value, boolean validate) Adds a new AnnotationRef element to this object.
void	addToAnnotationRef_List(AnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
void	setplane_choice(Plane_Choice value, boolean validate) Sets the value of the plane_choice element.
void	setplane_choice(Plane_Choice value) Sets the value of the plane_choice element.
Plane_Choice	getplane_choice() Returns the value of the plane_choice element.
void	resetplane_choice() Resets the plane_choice element to an unset state.
boolean	hasplane_choice() Checks whether the optional plane_choice element is present.
Plane	__internal_create(long cPtr, boolean own)
Plane	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions¶

	Name
	Plane(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Plane obj)

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.Plane;

Represents the XML element Plane.

Each Image has to have at least one Plane and one Channel. The Plane element holds the Microscope stage and Image timing data for a given Channel/z-section/timepoint. The total number of Plane elements for a given Image must equal to SizeZ x SizeC x SizeT.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function Plane¶

public Plane()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID¶

public void setID(
    PlaneID_Type value,
    boolean validate
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A unique identifier for this Plane.

function setID¶

public void setID(
    PlaneID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

A unique identifier for this Plane.

function getID¶

public PlaneID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

A unique identifier for this Plane.

function resetID¶

public void resetID()

Resets the ID attribute to an unset state.

A unique identifier for this Plane.

function hasID¶

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

A unique identifier for this Plane.

function setTheZ¶

public void setTheZ(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the TheZ attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the Z-section to which this Plane corresponds. This is numbered from 0.

function setTheZ¶

public void setTheZ(
    NonNegativeInt_Type value
)

Sets the value of the TheZ attribute.

Parameters:

value The value to set

This field records the Z-section to which this Plane corresponds. This is numbered from 0.

function getTheZ¶

public NonNegativeInt_Type getTheZ()

Returns the value of the TheZ attribute.

Return: The value of the attribute

This field records the Z-section to which this Plane corresponds. This is numbered from 0.

function resetTheZ¶

public void resetTheZ()

Resets the TheZ attribute to an unset state.

This field records the Z-section to which this Plane corresponds. This is numbered from 0.

function hasTheZ¶

public boolean hasTheZ()

Checks whether the optional TheZ attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the Z-section to which this Plane corresponds. This is numbered from 0.

function setTheT¶

public void setTheT(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the TheT attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records th Timepoint to which this Plane corresponds. This is numbered from 0.

function setTheT¶

public void setTheT(
    NonNegativeInt_Type value
)

Sets the value of the TheT attribute.

Parameters:

value The value to set

This field records th Timepoint to which this Plane corresponds. This is numbered from 0.

function getTheT¶

public NonNegativeInt_Type getTheT()

Returns the value of the TheT attribute.

Return: The value of the attribute

This field records th Timepoint to which this Plane corresponds. This is numbered from 0.

function resetTheT¶

public void resetTheT()

Resets the TheT attribute to an unset state.

This field records th Timepoint to which this Plane corresponds. This is numbered from 0.

function hasTheT¶

public boolean hasTheT()

Checks whether the optional TheT attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records th Timepoint to which this Plane corresponds. This is numbered from 0.

function setTheC¶

public void setTheC(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the TheC attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records th Channel to which this Plane corresponds. This is numbered from 0.

function setTheC¶

public void setTheC(
    NonNegativeInt_Type value
)

Sets the value of the TheC attribute.

Parameters:

value The value to set

This field records th Channel to which this Plane corresponds. This is numbered from 0.

function getTheC¶

public NonNegativeInt_Type getTheC()

Returns the value of the TheC attribute.

Return: The value of the attribute

This field records th Channel to which this Plane corresponds. This is numbered from 0.

function resetTheC¶

public void resetTheC()

Resets the TheC attribute to an unset state.

This field records th Channel to which this Plane corresponds. This is numbered from 0.

function hasTheC¶

public boolean hasTheC()

Checks whether the optional TheC attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records th Channel to which this Plane corresponds. This is numbered from 0.

function setTimestamp¶

public void setTimestamp(
    float value,
    boolean validate
)

Sets the value of the Timestamp attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the time at which this Plane was acquired as recorded from the beginning of Image Acquisition.

function setTimestamp¶

public void setTimestamp(
    float value
)

Sets the value of the Timestamp attribute.

Parameters:

value The value to set

This field records the time at which this Plane was acquired as recorded from the beginning of Image Acquisition.

function getTimestamp¶

public float getTimestamp()

Returns the value of the Timestamp attribute.

Return: The value of the attribute

This field records the time at which this Plane was acquired as recorded from the beginning of Image Acquisition.

function resetTimestamp¶

public void resetTimestamp()

Resets the Timestamp attribute to an unset state.

This field records the time at which this Plane was acquired as recorded from the beginning of Image Acquisition.

function hasTimestamp¶

public boolean hasTimestamp()

Checks whether the Timestamp attribute is present.

Return: true if the attribute has been set, false otherwise

This field records the time at which this Plane was acquired as recorded from the beginning of Image Acquisition.

function setTimestampUnit¶

public void setTimestampUnit(
    UnitsTime_Type value,
    boolean validate
)

Sets the value of the TimestampUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setTimestampUnit¶

public void setTimestampUnit(
    UnitsTime_Type value
)

Sets the value of the TimestampUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getTimestampUnit¶

public UnitsTime_Type getTimestampUnit()

Returns the value of the TimestampUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetTimestampUnit¶

public void resetTimestampUnit()

Resets the TimestampUnit attribute to an unset state.

No description available in the XSD standard.

function hasTimestampUnit¶

public boolean hasTimestampUnit()

Checks whether the optional TimestampUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setExposureTime¶

public void setExposureTime(
    float value,
    boolean validate
)

Sets the value of the ExposureTime attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the duration of the Exposure utilized to acquire this Plane.

function setExposureTime¶

public void setExposureTime(
    float value
)

Sets the value of the ExposureTime attribute.

Parameters:

value The value to set

This field records the duration of the Exposure utilized to acquire this Plane.

function getExposureTime¶

public float getExposureTime()

Returns the value of the ExposureTime attribute.

Return: The value of the attribute

This field records the duration of the Exposure utilized to acquire this Plane.

function resetExposureTime¶

public void resetExposureTime()

Resets the ExposureTime attribute to an unset state.

This field records the duration of the Exposure utilized to acquire this Plane.

function hasExposureTime¶

public boolean hasExposureTime()

Checks whether the ExposureTime attribute is present.

Return: true if the attribute has been set, false otherwise

This field records the duration of the Exposure utilized to acquire this Plane.

function setExposureTimeUnit¶

public void setExposureTimeUnit(
    UnitsTime_Type value,
    boolean validate
)

Sets the value of the ExposureTimeUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setExposureTimeUnit¶

public void setExposureTimeUnit(
    UnitsTime_Type value
)

Sets the value of the ExposureTimeUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getExposureTimeUnit¶

public UnitsTime_Type getExposureTimeUnit()

Returns the value of the ExposureTimeUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetExposureTimeUnit¶

public void resetExposureTimeUnit()

Resets the ExposureTimeUnit attribute to an unset state.

No description available in the XSD standard.

function hasExposureTimeUnit¶

public boolean hasExposureTimeUnit()

Checks whether the optional ExposureTimeUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setPixelDwellTime¶

public void setPixelDwellTime(
    float value,
    boolean validate
)

Sets the value of the PixelDwellTime attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This value typically refers to the settings applied to the Confocal Scanner during Acquisition, and it assumes that Pixel Dwell Time was set uniformly throughout the Plane. The Pixel Dwell Time represents the time this Confocal Scanner was set to dwell upon each pixel during the acquisition of this Plane (e.g. 1.58 µsec/pixel). The higher the Pixel Dwell Time the slower is the scan speed, the higher the sensitivity but also the potential photobleaching.

function setPixelDwellTime¶

public void setPixelDwellTime(
    float value
)

Sets the value of the PixelDwellTime attribute.

Parameters:

value The value to set

This value typically refers to the settings applied to the Confocal Scanner during Acquisition, and it assumes that Pixel Dwell Time was set uniformly throughout the Plane. The Pixel Dwell Time represents the time this Confocal Scanner was set to dwell upon each pixel during the acquisition of this Plane (e.g. 1.58 µsec/pixel). The higher the Pixel Dwell Time the slower is the scan speed, the higher the sensitivity but also the potential photobleaching.

function getPixelDwellTime¶

public float getPixelDwellTime()

Returns the value of the PixelDwellTime attribute.

Return: The value of the attribute

This value typically refers to the settings applied to the Confocal Scanner during Acquisition, and it assumes that Pixel Dwell Time was set uniformly throughout the Plane. The Pixel Dwell Time represents the time this Confocal Scanner was set to dwell upon each pixel during the acquisition of this Plane (e.g. 1.58 µsec/pixel). The higher the Pixel Dwell Time the slower is the scan speed, the higher the sensitivity but also the potential photobleaching.

function resetPixelDwellTime¶

public void resetPixelDwellTime()

Resets the PixelDwellTime attribute to an unset state.

This value typically refers to the settings applied to the Confocal Scanner during Acquisition, and it assumes that Pixel Dwell Time was set uniformly throughout the Plane. The Pixel Dwell Time represents the time this Confocal Scanner was set to dwell upon each pixel during the acquisition of this Plane (e.g. 1.58 µsec/pixel). The higher the Pixel Dwell Time the slower is the scan speed, the higher the sensitivity but also the potential photobleaching.

function hasPixelDwellTime¶

public boolean hasPixelDwellTime()

Checks whether the PixelDwellTime attribute is present.

Return: true if the attribute has been set, false otherwise

This value typically refers to the settings applied to the Confocal Scanner during Acquisition, and it assumes that Pixel Dwell Time was set uniformly throughout the Plane. The Pixel Dwell Time represents the time this Confocal Scanner was set to dwell upon each pixel during the acquisition of this Plane (e.g. 1.58 µsec/pixel). The higher the Pixel Dwell Time the slower is the scan speed, the higher the sensitivity but also the potential photobleaching.

function setPixelDwellTimeUnit¶

public void setPixelDwellTimeUnit(
    UnitsTime_Type value,
    boolean validate
)

Sets the value of the PixelDwellTimeUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPixelDwellTimeUnit¶

public void setPixelDwellTimeUnit(
    UnitsTime_Type value
)

Sets the value of the PixelDwellTimeUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getPixelDwellTimeUnit¶

public UnitsTime_Type getPixelDwellTimeUnit()

Returns the value of the PixelDwellTimeUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetPixelDwellTimeUnit¶

public void resetPixelDwellTimeUnit()

Resets the PixelDwellTimeUnit attribute to an unset state.

No description available in the XSD standard.

function hasPixelDwellTimeUnit¶

public boolean hasPixelDwellTimeUnit()

Checks whether the optional PixelDwellTimeUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setPositionX¶

public void setPositionX(
    float value,
    boolean validate
)

Sets the value of the PositionX attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the X position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function setPositionX¶

public void setPositionX(
    float value
)

Sets the value of the PositionX attribute.

Parameters:

value The value to set

This field records the X position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function getPositionX¶

public float getPositionX()

Returns the value of the PositionX attribute.

Return: The value of the attribute

This field records the X position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function resetPositionX¶

public void resetPositionX()

Resets the PositionX attribute to an unset state.

This field records the X position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function hasPositionX¶

public boolean hasPositionX()

Checks whether the PositionX attribute is present.

Return: true if the attribute has been set, false otherwise

This field records the X position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function setPositionXUnit¶

public void setPositionXUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the PositionXUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPositionXUnit¶

public void setPositionXUnit(
    UnitsLength_Type value
)

Sets the value of the PositionXUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getPositionXUnit¶

public UnitsLength_Type getPositionXUnit()

Returns the value of the PositionXUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetPositionXUnit¶

public void resetPositionXUnit()

Resets the PositionXUnit attribute to an unset state.

No description available in the XSD standard.

function hasPositionXUnit¶

public boolean hasPositionXUnit()

Checks whether the optional PositionXUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setPositionY¶

public void setPositionY(
    float value,
    boolean validate
)

Sets the value of the PositionY attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the Y position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function setPositionY¶

public void setPositionY(
    float value
)

Sets the value of the PositionY attribute.

Parameters:

value The value to set

This field records the Y position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function getPositionY¶

public float getPositionY()

Returns the value of the PositionY attribute.

Return: The value of the attribute

This field records the Y position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function resetPositionY¶

public void resetPositionY()

Resets the PositionY attribute to an unset state.

This field records the Y position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function hasPositionY¶

public boolean hasPositionY()

Checks whether the PositionY attribute is present.

Return: true if the attribute has been set, false otherwise

This field records the Y position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function setPositionYUnit¶

public void setPositionYUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the PositionYUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPositionYUnit¶

public void setPositionYUnit(
    UnitsLength_Type value
)

Sets the value of the PositionYUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getPositionYUnit¶

public UnitsLength_Type getPositionYUnit()

Returns the value of the PositionYUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetPositionYUnit¶

public void resetPositionYUnit()

Resets the PositionYUnit attribute to an unset state.

No description available in the XSD standard.

function hasPositionYUnit¶

public boolean hasPositionYUnit()

Checks whether the optional PositionYUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setPositionZ¶

public void setPositionZ(
    float value,
    boolean validate
)

Sets the value of the PositionZ attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the Z position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function setPositionZ¶

public void setPositionZ(
    float value
)

Sets the value of the PositionZ attribute.

Parameters:

value The value to set

This field records the Z position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function getPositionZ¶

public float getPositionZ()

Returns the value of the PositionZ attribute.

Return: The value of the attribute

This field records the Z position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function resetPositionZ¶

public void resetPositionZ()

Resets the PositionZ attribute to an unset state.

This field records the Z position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function hasPositionZ¶

public boolean hasPositionZ()

Checks whether the PositionZ attribute is present.

Return: true if the attribute has been set, false otherwise

This field records the Z position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

function setPositionZUnit¶

public void setPositionZUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the PositionZUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPositionZUnit¶

public void setPositionZUnit(
    UnitsLength_Type value
)

Sets the value of the PositionZUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getPositionZUnit¶

public UnitsLength_Type getPositionZUnit()

Returns the value of the PositionZUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetPositionZUnit¶

public void resetPositionZUnit()

Resets the PositionZUnit attribute to an unset state.

No description available in the XSD standard.

function hasPositionZUnit¶

public boolean hasPositionZUnit()

Checks whether the optional PositionZUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setPlaneXOffset¶

public void setPlaneXOffset(
    float value,
    boolean validate
)

Sets the value of the PlaneXOffset attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the X offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

function setPlaneXOffset¶

public void setPlaneXOffset(
    float value
)

Sets the value of the PlaneXOffset attribute.

Parameters:

value The value to set

This field records the X offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

function getPlaneXOffset¶

public float getPlaneXOffset()

Returns the value of the PlaneXOffset attribute.

Return: The value of the attribute

This field records the X offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

function resetPlaneXOffset¶

public void resetPlaneXOffset()

Resets the PlaneXOffset attribute to an unset state.

This field records the X offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

function hasPlaneXOffset¶

public boolean hasPlaneXOffset()

Checks whether the PlaneXOffset attribute is present.

Return: true if the attribute has been set, false otherwise

This field records the X offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

function setPlaneYOffset¶

public void setPlaneYOffset(
    float value,
    boolean validate
)

Sets the value of the PlaneYOffset attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the Y offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

function setPlaneYOffset¶

public void setPlaneYOffset(
    float value
)

Sets the value of the PlaneYOffset attribute.

Parameters:

value The value to set

This field records the Y offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

function getPlaneYOffset¶

public float getPlaneYOffset()

Returns the value of the PlaneYOffset attribute.

Return: The value of the attribute

This field records the Y offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

function resetPlaneYOffset¶

public void resetPlaneYOffset()

Resets the PlaneYOffset attribute to an unset state.

This field records the Y offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

function hasPlaneYOffset¶

public boolean hasPlaneYOffset()

Checks whether the PlaneYOffset attribute is present.

Return: true if the attribute has been set, false otherwise

This field records the Y offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

function setPlaneZOffset¶

public void setPlaneZOffset(
    float value,
    boolean validate
)

Sets the value of the PlaneZOffset attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field describes the Z-offset imposed by the Focal Positioning device.

function setPlaneZOffset¶

public void setPlaneZOffset(
    float value
)

Sets the value of the PlaneZOffset attribute.

Parameters:

value The value to set

This field describes the Z-offset imposed by the Focal Positioning device.

function getPlaneZOffset¶

public float getPlaneZOffset()

Returns the value of the PlaneZOffset attribute.

Return: The value of the attribute

This field describes the Z-offset imposed by the Focal Positioning device.

function resetPlaneZOffset¶

public void resetPlaneZOffset()

Resets the PlaneZOffset attribute to an unset state.

This field describes the Z-offset imposed by the Focal Positioning device.

function hasPlaneZOffset¶

public boolean hasPlaneZOffset()

Checks whether the PlaneZOffset attribute is present.

Return: true if the attribute has been set, false otherwise

This field describes the Z-offset imposed by the Focal Positioning device.

function setMechanicalCalibration_List¶

public void setMechanicalCalibration_List(
    MechanicalCalibrationVector value,
    boolean validate
)

Sets the list of MechanicalCalibration elements.

Parameters:

value The new list of MechanicalCalibration elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setMechanicalCalibration_List¶

public void setMechanicalCalibration_List(
    MechanicalCalibrationVector value
)

Sets the list of MechanicalCalibration elements.

Parameters:

value The new list of MechanicalCalibration elements

No description available in the XSD standard.

function getMechanicalCalibration_List¶

public MechanicalCalibrationVector getMechanicalCalibration_List()

Returns the list of MechanicalCalibration elements.

Return: The list of MechanicalCalibration elements

No description available in the XSD standard.

function addToMechanicalCalibration_List¶

public void addToMechanicalCalibration_List(
    MechanicalCalibration value,
    boolean validate
)

Adds a new MechanicalCalibration element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToMechanicalCalibration_List¶

public void addToMechanicalCalibration_List(
    MechanicalCalibration value
)

Adds a new MechanicalCalibration element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearMechanicalCalibration_List¶

public void clearMechanicalCalibration_List()

Clear the list of MechanicalCalibration.

No description available in the XSD standard.

function setTheAdditionalDimensionRef_List¶

public void setTheAdditionalDimensionRef_List(
    TheAdditionalDimensionRefVector value,
    boolean validate
)

Sets the list of TheAdditionalDimensionRef elements.

Parameters:

value The new list of TheAdditionalDimensionRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setTheAdditionalDimensionRef_List¶

public void setTheAdditionalDimensionRef_List(
    TheAdditionalDimensionRefVector value
)

Sets the list of TheAdditionalDimensionRef elements.

Parameters:

value The new list of TheAdditionalDimensionRef elements

No description available in the XSD standard.

function getTheAdditionalDimensionRef_List¶

public TheAdditionalDimensionRefVector getTheAdditionalDimensionRef_List()

Returns the list of TheAdditionalDimensionRef elements.

Return: The list of TheAdditionalDimensionRef elements

No description available in the XSD standard.

function addToTheAdditionalDimensionRef_List¶

public void addToTheAdditionalDimensionRef_List(
    TheAdditionalDimensionRef value,
    boolean validate
)

Adds a new TheAdditionalDimensionRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToTheAdditionalDimensionRef_List¶

public void addToTheAdditionalDimensionRef_List(
    TheAdditionalDimensionRef value
)

Adds a new TheAdditionalDimensionRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearTheAdditionalDimensionRef_List¶

public void clearTheAdditionalDimensionRef_List()

Clear the list of TheAdditionalDimensionRef.

No description available in the XSD standard.

function setPlaneTransformationMatrix_List¶

public void setPlaneTransformationMatrix_List(
    PlaneTransformationMatrixVector value,
    boolean validate
)

Sets the list of PlaneTransformationMatrix elements.

Parameters:

value The new list of PlaneTransformationMatrix elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPlaneTransformationMatrix_List¶

public void setPlaneTransformationMatrix_List(
    PlaneTransformationMatrixVector value
)

Sets the list of PlaneTransformationMatrix elements.

Parameters:

value The new list of PlaneTransformationMatrix elements

No description available in the XSD standard.

function getPlaneTransformationMatrix_List¶

public PlaneTransformationMatrixVector getPlaneTransformationMatrix_List()

Returns the list of PlaneTransformationMatrix elements.

Return: The list of PlaneTransformationMatrix elements

No description available in the XSD standard.

function addToPlaneTransformationMatrix_List¶

public void addToPlaneTransformationMatrix_List(
    PlaneTransformationMatrix value,
    boolean validate
)

Adds a new PlaneTransformationMatrix element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToPlaneTransformationMatrix_List¶

public void addToPlaneTransformationMatrix_List(
    PlaneTransformationMatrix value
)

Adds a new PlaneTransformationMatrix element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearPlaneTransformationMatrix_List¶

public void clearPlaneTransformationMatrix_List()

Clear the list of PlaneTransformationMatrix.

No description available in the XSD standard.

function setAnnotationRef_List¶

public void setAnnotationRef_List(
    AnnotationRefVector value,
    boolean validate
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements
validate If true, validates constraints on value. Default is true.

This is a simple multi-line comment or annotation describing this component.

function setAnnotationRef_List¶

public void setAnnotationRef_List(
    AnnotationRefVector value
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef_List¶

public AnnotationRefVector getAnnotationRef_List()

Returns the list of AnnotationRef elements.

Return: The list of AnnotationRef elements

This is a simple multi-line comment or annotation describing this component.

function addToAnnotationRef_List¶

public void addToAnnotationRef_List(
    AnnotationRef value,
    boolean validate
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

This is a simple multi-line comment or annotation describing this component.

function addToAnnotationRef_List¶

public void addToAnnotationRef_List(
    AnnotationRef value
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add

This is a simple multi-line comment or annotation describing this component.

function clearAnnotationRef_List¶

public void clearAnnotationRef_List()

Clear the list of AnnotationRef.

This is a simple multi-line comment or annotation describing this component.

function setplane_choice¶

public void setplane_choice(
    Plane_Choice value,
    boolean validate
)

Sets the value of the plane_choice element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setplane_choice¶

public void setplane_choice(
    Plane_Choice value
)

Sets the value of the plane_choice element.

Parameters:

value The value to set

No description available in the XSD standard.

function getplane_choice¶

public Plane_Choice getplane_choice()

Returns the value of the plane_choice element.

Return: The value of the element

No description available in the XSD standard.

function resetplane_choice¶

public void resetplane_choice()

Resets the plane_choice element to an unset state.

No description available in the XSD standard.

function hasplane_choice¶

public boolean hasplane_choice()

Checks whether the optional plane_choice element is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function __internal_create¶

public static Plane __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

function fromBase¶

public static Plane fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Protected Functions Documentation¶

function Plane¶

protected Plane(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr¶

protected static long getCPtr(
    Plane obj
)

Updated on 2026-06-22 at 17:06:32 +0200